Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix GCC's ability to find the precompiled header #1268

Merged
merged 2 commits into from
May 10, 2024
Merged

Fix GCC's ability to find the precompiled header #1268

merged 2 commits into from
May 10, 2024

Conversation

WardBrian
Copy link
Member

Submisison Checklist

  • Run tests: ./runCmdStanTests.py src/test
  • Declare copyright holder and open-source license: see below

Summary:

In #1171 we added the version of the C++ compiler to the precompiled header file name. This works for clang, since we have to explicitly pass -include-pch path/to/header, but GCC does an implicit lookup. Since the filename didn't match, it failed.

This paragraph in the GCC manual saves us, though:

If you need to precompile the same header file for different languages, targets, or compiler options, you can instead make a directory named like all.h.gch, and put each precompiled header in the directory, perhaps using -o. It doesn’t matter what you call the files in the directory; every precompiled header in the directory is considered. The first precompiled header encountered in the directory that is valid for this compilation is used; they’re searched in no particular order.

So we just use that folder instead. Clang still won't care, since we're giving it the path explicitly, but gcc compile times are now back to what you'd expect.

Intended Effect:

How to Verify:

Compile with PRECOMPILED_HEADERS=false and then with them enabled, compare timings.

Side Effects:

Documentation:

Copyright and Licensing

Please list the copyright holder for the work you are submitting (this will be you or your assignee, such as a university or company):

By submitting this pull request, the copyright holder is agreeing to license the submitted work under the following licenses:

@WardBrian WardBrian requested a review from rok-cesnovar May 9, 2024 20:08
@stan-buildbot
Copy link
Contributor

Name Old Result New Result Ratio Performance change( 1 - new / old )
arma/arma.stan 0.2 0.2 0.97 -2.93% slower
low_dim_corr_gauss/low_dim_corr_gauss.stan 0.01 0.01 0.97 -2.73% slower
gp_regr/gen_gp_data.stan 0.02 0.02 0.98 -1.93% slower
gp_regr/gp_regr.stan 0.11 0.11 0.98 -2.06% slower
sir/sir.stan 79.77 87.06 0.92 -9.14% slower
irt_2pl/irt_2pl.stan 4.0 4.93 0.81 -23.13% slower
eight_schools/eight_schools.stan 0.06 0.06 0.98 -2.47% slower
pkpd/sim_one_comp_mm_elim_abs.stan 0.25 0.28 0.92 -8.79% slower
pkpd/one_comp_mm_elim_abs.stan 18.53 18.56 1.0 -0.13% slower
garch/garch.stan 0.48 0.47 1.04 3.52% faster
low_dim_gauss_mix/low_dim_gauss_mix.stan 2.92 3.13 0.93 -7.32% slower
arK/arK.stan 1.68 1.99 0.85 -18.04% slower
gp_pois_regr/gp_pois_regr.stan 2.61 2.6 1.01 0.57% faster
low_dim_gauss_mix_collapse/low_dim_gauss_mix_collapse.stan 9.53 9.63 0.99 -1.08% slower
performance.compilation 198.49 187.35 1.06 5.61% faster
Mean result: 0.9598692294116096

Jenkins Console Log
Blue Ocean
Commit hash: 8229477b6234d7c8fc557a960b090f5699c54683

Machine information No LSB modules are available. Distributor ID: Ubuntu Description: Ubuntu 20.04.3 LTS Release: 20.04 Codename: focal

CPU:
Architecture: x86_64
CPU op-mode(s): 32-bit, 64-bit
Byte Order: Little Endian
Address sizes: 46 bits physical, 48 bits virtual
CPU(s): 80
On-line CPU(s) list: 0-79
Thread(s) per core: 2
Core(s) per socket: 20
Socket(s): 2
NUMA node(s): 2
Vendor ID: GenuineIntel
CPU family: 6
Model: 85
Model name: Intel(R) Xeon(R) Gold 6148 CPU @ 2.40GHz
Stepping: 4
CPU MHz: 2400.000
CPU max MHz: 3700.0000
CPU min MHz: 1000.0000
BogoMIPS: 4800.00
Virtualization: VT-x
L1d cache: 1.3 MiB
L1i cache: 1.3 MiB
L2 cache: 40 MiB
L3 cache: 55 MiB
NUMA node0 CPU(s): 0,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,38,40,42,44,46,48,50,52,54,56,58,60,62,64,66,68,70,72,74,76,78
NUMA node1 CPU(s): 1,3,5,7,9,11,13,15,17,19,21,23,25,27,29,31,33,35,37,39,41,43,45,47,49,51,53,55,57,59,61,63,65,67,69,71,73,75,77,79
Vulnerability Gather data sampling: Mitigation; Microcode
Vulnerability Itlb multihit: KVM: Mitigation: VMX disabled
Vulnerability L1tf: Mitigation; PTE Inversion; VMX conditional cache flushes, SMT vulnerable
Vulnerability Mds: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Meltdown: Mitigation; PTI
Vulnerability Mmio stale data: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Retbleed: Mitigation; IBRS
Vulnerability Spec rstack overflow: Not affected
Vulnerability Spec store bypass: Mitigation; Speculative Store Bypass disabled via prctl
Vulnerability Spectre v1: Mitigation; usercopy/swapgs barriers and __user pointer sanitization
Vulnerability Spectre v2: Mitigation; IBRS, IBPB conditional, STIBP conditional, RSB filling, PBRSB-eIBRS Not affected
Vulnerability Srbds: Not affected
Vulnerability Tsx async abort: Mitigation; Clear CPU buffers; SMT vulnerable
Flags: fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush dts acpi mmx fxsr sse sse2 ss ht tm pbe syscall nx pdpe1gb rdtscp lm constant_tsc art arch_perfmon pebs bts rep_good nopl xtopology nonstop_tsc cpuid aperfmperf pni pclmulqdq dtes64 monitor ds_cpl vmx smx est tm2 ssse3 sdbg fma cx16 xtpr pdcm pcid dca sse4_1 sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx f16c rdrand lahf_lm abm 3dnowprefetch cpuid_fault epb cat_l3 cdp_l3 invpcid_single pti intel_ppin ssbd mba ibrs ibpb stibp tpr_shadow vnmi flexpriority ept vpid ept_ad fsgsbase tsc_adjust bmi1 hle avx2 smep bmi2 erms invpcid rtm cqm mpx rdt_a avx512f avx512dq rdseed adx smap clflushopt clwb intel_pt avx512cd avx512bw avx512vl xsaveopt xsavec xgetbv1 xsaves cqm_llc cqm_occup_llc cqm_mbm_total cqm_mbm_local dtherm ida arat pln pts hwp hwp_act_window hwp_epp hwp_pkg_req pku ospke md_clear flush_l1d arch_capabilities

G++:
g++ (Ubuntu 9.4.0-1ubuntu1~20.04) 9.4.0
Copyright (C) 2019 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Clang:
clang version 10.0.0-4ubuntu1
Target: x86_64-pc-linux-gnu
Thread model: posix
InstalledDir: /usr/bin

@stan-buildbot
Copy link
Contributor

Name Old Result New Result Ratio Performance change( 1 - new / old )
arma/arma.stan 0.24 0.21 1.16 13.5% faster
low_dim_corr_gauss/low_dim_corr_gauss.stan 0.01 0.01 1.17 14.37% faster
gp_regr/gen_gp_data.stan 0.03 0.02 1.08 7.57% faster
gp_regr/gp_regr.stan 0.12 0.11 1.07 6.36% faster
sir/sir.stan 98.54 82.72 1.19 16.05% faster
irt_2pl/irt_2pl.stan 5.61 4.14 1.36 26.24% faster
eight_schools/eight_schools.stan 0.06 0.06 1.07 6.44% faster
pkpd/sim_one_comp_mm_elim_abs.stan 0.28 0.26 1.05 5.18% faster
pkpd/one_comp_mm_elim_abs.stan 20.23 19.07 1.06 5.76% faster
garch/garch.stan 0.53 0.46 1.14 12.02% faster
low_dim_gauss_mix/low_dim_gauss_mix.stan 3.24 4.28 0.76 -32.16% slower
arK/arK.stan 1.86 1.68 1.11 9.54% faster
gp_pois_regr/gp_pois_regr.stan 2.94 4.49 0.66 -52.67% slower
low_dim_gauss_mix_collapse/low_dim_gauss_mix_collapse.stan 11.23 9.61 1.17 14.4% faster
performance.compilation 253.83 189.33 1.34 25.41% faster
Mean result: 1.0912024788107948

Jenkins Console Log
Blue Ocean
Commit hash: 8229477b6234d7c8fc557a960b090f5699c54683

Machine information No LSB modules are available. Distributor ID: Ubuntu Description: Ubuntu 20.04.3 LTS Release: 20.04 Codename: focal

CPU:
Architecture: x86_64
CPU op-mode(s): 32-bit, 64-bit
Byte Order: Little Endian
Address sizes: 46 bits physical, 48 bits virtual
CPU(s): 80
On-line CPU(s) list: 0-79
Thread(s) per core: 2
Core(s) per socket: 20
Socket(s): 2
NUMA node(s): 2
Vendor ID: GenuineIntel
CPU family: 6
Model: 85
Model name: Intel(R) Xeon(R) Gold 6148 CPU @ 2.40GHz
Stepping: 4
CPU MHz: 2400.000
CPU max MHz: 3700.0000
CPU min MHz: 1000.0000
BogoMIPS: 4800.00
Virtualization: VT-x
L1d cache: 1.3 MiB
L1i cache: 1.3 MiB
L2 cache: 40 MiB
L3 cache: 55 MiB
NUMA node0 CPU(s): 0,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,38,40,42,44,46,48,50,52,54,56,58,60,62,64,66,68,70,72,74,76,78
NUMA node1 CPU(s): 1,3,5,7,9,11,13,15,17,19,21,23,25,27,29,31,33,35,37,39,41,43,45,47,49,51,53,55,57,59,61,63,65,67,69,71,73,75,77,79
Vulnerability Gather data sampling: Mitigation; Microcode
Vulnerability Itlb multihit: KVM: Mitigation: VMX disabled
Vulnerability L1tf: Mitigation; PTE Inversion; VMX conditional cache flushes, SMT vulnerable
Vulnerability Mds: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Meltdown: Mitigation; PTI
Vulnerability Mmio stale data: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Retbleed: Mitigation; IBRS
Vulnerability Spec rstack overflow: Not affected
Vulnerability Spec store bypass: Mitigation; Speculative Store Bypass disabled via prctl
Vulnerability Spectre v1: Mitigation; usercopy/swapgs barriers and __user pointer sanitization
Vulnerability Spectre v2: Mitigation; IBRS, IBPB conditional, STIBP conditional, RSB filling, PBRSB-eIBRS Not affected
Vulnerability Srbds: Not affected
Vulnerability Tsx async abort: Mitigation; Clear CPU buffers; SMT vulnerable
Flags: fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush dts acpi mmx fxsr sse sse2 ss ht tm pbe syscall nx pdpe1gb rdtscp lm constant_tsc art arch_perfmon pebs bts rep_good nopl xtopology nonstop_tsc cpuid aperfmperf pni pclmulqdq dtes64 monitor ds_cpl vmx smx est tm2 ssse3 sdbg fma cx16 xtpr pdcm pcid dca sse4_1 sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx f16c rdrand lahf_lm abm 3dnowprefetch cpuid_fault epb cat_l3 cdp_l3 invpcid_single pti intel_ppin ssbd mba ibrs ibpb stibp tpr_shadow vnmi flexpriority ept vpid ept_ad fsgsbase tsc_adjust bmi1 hle avx2 smep bmi2 erms invpcid rtm cqm mpx rdt_a avx512f avx512dq rdseed adx smap clflushopt clwb intel_pt avx512cd avx512bw avx512vl xsaveopt xsavec xgetbv1 xsaves cqm_llc cqm_occup_llc cqm_mbm_total cqm_mbm_local dtherm ida arat pln pts hwp hwp_act_window hwp_epp hwp_pkg_req pku ospke md_clear flush_l1d arch_capabilities

G++:
g++ (Ubuntu 9.4.0-1ubuntu1~20.04) 9.4.0
Copyright (C) 2019 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Clang:
clang version 10.0.0-4ubuntu1
Target: x86_64-pc-linux-gnu
Thread model: posix
InstalledDir: /usr/bin

rok-cesnovar
rok-cesnovar approved these changes May 10, 2024
View reviewed changes
Copy link
Member

@rok-cesnovar rok-cesnovar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice find! So the last versions had slower compile times with g++?

@WardBrian
Copy link
Member Author

Yes, and I guess it slipped under the radar

@WardBrian WardBrian merged commit cdd2791 into develop May 10, 2024
1 check passed
@WardBrian WardBrian deleted the makefile/gcc-precompiled-header-finding branch May 10, 2024 12:31
@WardBrian WardBrian mentioned this pull request May 13, 2024
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rok-cesnovar rok-cesnovar rok-cesnovar approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@WardBrian @stan-buildbot @rok-cesnovar